home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / old-compression / clAddParam.z / clAddParam
Encoding:
Text File  |  2002-10-03  |  7.3 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ccccllllAAAAddddddddPPPPaaaarrrraaaammmm((((3333ddddmmmm))))                                                ccccllllAAAAddddddddPPPPaaaarrrraaaammmm((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      clAddParam, clSetDefault, clSetMin, clSetMax, clSetMinMax, clSetRange -
  10.      Add a video or audio compression parameter to the Compression Library
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ccccllll....hhhh>>>>
  14.  
  15.      iiiinnnntttt ccccllllAAAAddddddddPPPPaaaarrrraaaammmm((((iiiinnnntttt sssscccchhhheeeemmmmeeee,,,, cccchhhhaaaarrrr ****nnnnaaaammmmeeee,,,, iiiinnnntttt ppppaaaarrrraaaammmmTTTTyyyyppppeeee,,,,
  16.          iiiinnnntttt mmmmiiiinnnn,,,, iiiinnnntttt mmmmaaaaxxxx,,,, iiiinnnntttt iiiinnnniiiittttiiiiaaaallll,,,, iiiinnnntttt ****ppppaaaarrrraaaammmmIIIIDDDDPPPPttttrrrr))))
  17.  
  18.      iiiinnnntttt ccccllllSSSSeeeettttDDDDeeeeffffaaaauuuulllltttt((((iiiinnnntttt sssscccchhhheeeemmmmeeee,,,, iiiinnnntttt ppppaaaarrrraaaammmmIIIIDDDD,,,, iiiinnnntttt iiiinnnniiiittttiiiiaaaallll))))
  19.      iiiinnnntttt ccccllllSSSSeeeettttMMMMiiiinnnn((((iiiinnnntttt sssscccchhhheeeemmmmeeee,,,, iiiinnnntttt ppppaaaarrrraaaammmmIIIIDDDD,,,, iiiinnnntttt mmmmiiiinnnn))))
  20.      iiiinnnntttt ccccllllSSSSeeeettttMMMMaaaaxxxx((((iiiinnnntttt sssscccchhhheeeemmmmeeee,,,, iiiinnnntttt ppppaaaarrrraaaammmmIIIIDDDD,,,, iiiinnnntttt mmmmaaaaxxxx))))
  21.      iiiinnnntttt ccccllllSSSSeeeettttMMMMiiiinnnnMMMMaaaaxxxx((((iiiinnnntttt sssscccchhhheeeemmmmeeee,,,, iiiinnnntttt ppppaaaarrrraaaammmmIIIIDDDD,,,, iiiinnnntttt mmmmiiiinnnn,,,, iiiinnnntttt mmmmaaaaxxxx))))
  22.      iiiinnnntttt ccccllllSSSSeeeettttRRRRaaaannnnggggeeee((((iiiinnnntttt sssscccchhhheeeemmmmeeee,,,, iiiinnnntttt ppppaaaarrrraaaammmmIIIIDDDD,,,, iiiinnnntttt mmmmiiiinnnn,,,, iiiinnnntttt mmmmaaaaxxxx,,,, iiiinnnntttt iiiinnnniiiittttiiiiaaaallll))))
  23.  
  24. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  25.      _s_c_h_e_m_e    The compression scheme that gets the added parameter.
  26.  
  27.      _n_a_m_e      A pointer to a string that contains the name of the parameter.
  28.  
  29.      _p_a_r_a_m_T_y_p_e The type of the parameter (CCCCLLLL____EEEENNNNUUUUMMMM____VVVVAAAALLLLUUUUEEEE, CCCCLLLL____RRRRAAAANNNNGGGGEEEE____VVVVAAAALLLLUUUUEEEE,
  30.                CCCCLLLL____FFFFLLLLOOOOAAAATTTTIIIINNNNGGGG____EEEENNNNUUUUMMMM____VVVVAAAALLLLUUUUEEEE, or CCCCLLLL____FFFFLLLLOOOOAAAATTTTIIIINNNNGGGG____RRRRAAAANNNNGGGGEEEE____VVVVAAAALLLLUUUUEEEE).
  31.  
  32.      _m_i_n       The minimum value the parameter can have.
  33.  
  34.      _m_a_x       The maximum value the parameter can have.
  35.  
  36.      _i_n_i_t_i_a_l   The default value of the parameter.
  37.  
  38.      _p_a_r_a_m_I_D_P_t_r
  39.                A pointer to an int value that is to receive the new parameter
  40.                identifier.
  41.  
  42.      _p_a_r_a_m_I_D   The parameter identifier.
  43.  
  44.      New codecs introduced with ccccllllAAAAddddddddAAAAllllggggoooorrrriiiitttthhhhmmmm may also have custom parameters
  45.      added with ccccllllAAAAddddddddPPPPaaaarrrraaaammmm.  Once added, these parameters are accessible by
  46.      applications using standard API calls such as ccccllllGGGGeeeettttPPPPaaaarrrraaaammmmssss and
  47.      ccccllllSSSSeeeettttPPPPaaaarrrraaaammmmssss.
  48.  
  49.      ccccllllSSSSeeeettttDDDDeeeeffffaaaauuuulllltttt, ccccllllSSSSeeeettttMMMMiiiinnnn, ccccllllSSSSeeeettttMMMMaaaaxxxx, ccccllllSSSSeeeettttMMMMiiiinnnnMMMMaaaaxxxx, and ccccllllSSSSeeeettttRRRRaaaannnnggggeeee may be used
  50.      to configure a new parameter after it is added.
  51.  
  52.  
  53. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  54.      ccccllllAAAAddddddddPPPPaaaarrrraaaammmm, ccccllllSSSSeeeettttMMMMiiiinnnnMMMMaaaaxxxx, and ccccllllSSSSeeeettttRRRRaaaannnnggggeeee return SUCCESS, or a negative
  55.      error code on failure.  ccccllllSSSSeeeettttDDDDeeeeffffaaaauuuulllltttt, ccccllllSSSSeeeettttMMMMiiiinnnn, and ccccllllSSSSeeeettttMMMMaaaaxxxx return the
  56.      previous default, min, and max values, respectively, or negative error
  57.      codes on failure.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ccccllllAAAAddddddddPPPPaaaarrrraaaammmm((((3333ddddmmmm))))                                                ccccllllAAAAddddddddPPPPaaaarrrraaaammmm((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  75.           #include <dmedia/cl.h>
  76.  
  77.           int newScheme;
  78.           int newParamID;
  79.            ...
  80.           /* Add a new algorithm */
  81.           clAddAlgorithm("New Algorithm", CL_ALG_VIDEO,
  82.               NEW_ALGORITHM_MAX_HEADER_SIZE,
  83.               OpenNewCompressor, CompressNew, CloseNewCompressor,
  84.               OpenNewDecompressor, DecompressNew, CloseNewDecompressor,
  85.               ReadNewHeader, QueryNewScheme, QueryNewLicense,
  86.               GetNewParams, SetNewParams,
  87.               &newScheme);
  88.  
  89.           /* Add a new parameter */
  90.           clAddParam(newScheme, "New Parameter", CL_RANGE_VALUE, 0, 100, 75,
  91.                      &newParamID);
  92.            ...
  93.           /* Compress a series of frames */
  94.           clOpenCompressor(newScheme, &handle);
  95.  
  96.           clSetParam(handle, newParamID, 55);
  97.            ...
  98.  
  99.  
  100.  
  101. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  102.      CLintro(3dm), clAddAlgorithm(3dm), clSetUnique(3dm), clGetUnique(3dm),
  103.      clFetchParam(3dm), clStoreParam(3dm), clError(3dm), clGetDefault(3dm),
  104.      clGetMinMax(3dm)
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.